From b4e86302701f771c5d89ead99258ecffbc29dfb2 Mon Sep 17 00:00:00 2001 From: Yehuda Katz Date: Mon, 23 Jun 2014 17:02:22 -0700 Subject: [PATCH] Fix the README --- README.md | 77 +++---------------------------------------------------- 1 file changed, 4 insertions(+), 73 deletions(-) diff --git a/README.md b/README.md index fb6d941bb..c0e434eba 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,7 @@ +Cargo downloads your Rust project’s dependencies and compiles your project. + +Learn more at http://crates.io/. + ## Compiling cargo You'll want to clone cargo using --recursive on git, to clone in it's submodule dependencies. @@ -11,76 +15,3 @@ $ git submodule update ``` Then it's as simple as ```make``` and you're ready to go. -## Porcelain - -### cargo-compile - -``` -$ cargo compile -``` - -This command assumes the following directory structure: - -``` -|Cargo.toml -|~src -| | {main,lib}.rs -|~target -| |~x86_64-apple-darwin -| | |~lib -| | | |~[symlinked dependencies] -| | | | [build artifacts] -| |~... -``` - -When running `cargo compile`, Cargo runs the following steps: - -* `cargo verify --manifest=[location of Cargo.toml]` -* ... TODO: dependency resolution and downloading ... -* `cargo prepare` -* `cargo rustc --out-dir=[from Cargo.toml]/[platform] -L [from Cargo.toml]/[platform]/lib ...` - -## Plumbing - -### cargo-verify - -``` -$ cargo verify --manifest=MANIFEST -``` - -Verifies that the manifest is in the location specified, in a valid -format, and contains all of the required sections. - -#### Success - -``` -{ "success": true } -``` - -#### Errors - -``` -{ - "invalid": < "not-found" | "invalid-format" >, - "missing-field": [ required-field... ], - "missing-source": bool, - "unwritable-target": bool -} -``` - -### cargo-rustc - -``` -$ cargo rustc --out-dir=LOCATION -L LIBDIR -- ...ARGS -``` - -### cargo-prepare - -Prepare the directories (including symlinking dependency libraries) to -be ready for the flags Cargo plans to pass into `rustc`. - -## NOTES and OPEN QUESTIONS - -* We need to support per-platform calls to `make` (et al) to build - native (mostly C) code. Should this be part of `prepare` or a - different step between `prepare` and `cargo-rustc`. -- 2.30.2